<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.19"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Simple TDMA implementation for OMNeT++: RlcCore Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Simple TDMA implementation for OMNeT++
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.19 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_rlc_core-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">RlcCore Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="class_rlc_core.html" title="RlcCore is a pure C++ implementation of the fragmentation/reassembly logic.">RlcCore</a> is a pure C++ implementation of the fragmentation/reassembly logic.  
 <a href="class_rlc_core.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_rlc_core_8h_source.html">RlcCore.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af80dce9c135e008c7945f7df80dabb40"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_rlc_core.html#af80dce9c135e008c7945f7df80dabb40">RlcCore</a> ()</td></tr>
<tr class="separator:af80dce9c135e008c7945f7df80dabb40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a583a1eb22d4e0a112998d195d733cb75"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_rlc_core.html#a583a1eb22d4e0a112998d195d733cb75">~RlcCore</a> ()</td></tr>
<tr class="separator:a583a1eb22d4e0a112998d195d733cb75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4574f7e2ec51323c53bf2f32fb94c986"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_rlc_core.html#a4574f7e2ec51323c53bf2f32fb94c986">addFrame</a> (<a class="el" href="struct_abstract_frame.html">AbstractFrame</a> frame)</td></tr>
<tr class="separator:a4574f7e2ec51323c53bf2f32fb94c986"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08d196d5209401ed68cd99d7ec2875f0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_rlc_core.html#a08d196d5209401ed68cd99d7ec2875f0">addPacket</a> (<a class="el" href="struct_abstract_packet.html">AbstractPacket</a> packet)</td></tr>
<tr class="separator:a08d196d5209401ed68cd99d7ec2875f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02472c960e8a4bd52c3ae638f055af0e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_rlc_core.html#a02472c960e8a4bd52c3ae638f055af0e">hasFrame</a> ()</td></tr>
<tr class="separator:a02472c960e8a4bd52c3ae638f055af0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c9ad4e279f99d546d621442acea6064"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_abstract_frame.html">AbstractFrame</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_rlc_core.html#a7c9ad4e279f99d546d621442acea6064">getFrame</a> (int size)</td></tr>
<tr class="separator:a7c9ad4e279f99d546d621442acea6064"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71b029f8a8e64f46dc27815ca1e7f27a"><td class="memItemLeft" align="right" valign="top">vector&lt; <a class="el" href="struct_abstract_packet.html">AbstractPacket</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_rlc_core.html#a71b029f8a8e64f46dc27815ca1e7f27a">getCompletePackets</a> ()</td></tr>
<tr class="separator:a71b029f8a8e64f46dc27815ca1e7f27a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a48c71d3a03e5e2231b38b3b2722cfc43"><td class="memItemLeft" align="right" valign="top">vector&lt; <a class="el" href="struct_abstract_frame.html">AbstractFrame</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_rlc_core.html#a48c71d3a03e5e2231b38b3b2722cfc43">receivedFrames</a></td></tr>
<tr class="separator:a48c71d3a03e5e2231b38b3b2722cfc43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97af5f125410bb76b884e130b7602262"><td class="memItemLeft" align="right" valign="top">vector&lt; <a class="el" href="struct_abstract_packet.html">AbstractPacket</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_rlc_core.html#a97af5f125410bb76b884e130b7602262">packetQueue</a></td></tr>
<tr class="separator:a97af5f125410bb76b884e130b7602262"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_rlc_core.html" title="RlcCore is a pure C++ implementation of the fragmentation/reassembly logic.">RlcCore</a> is a pure C++ implementation of the fragmentation/reassembly logic. </p>
<p>More to come... </p><dl class="section author"><dt>Author</dt><dd>Konrad Fuger, TUHH ComNets </dd></dl>
<dl class="section date"><dt>Date</dt><dd>August 2020 </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af80dce9c135e008c7945f7df80dabb40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af80dce9c135e008c7945f7df80dabb40">&#9670;&nbsp;</a></span>RlcCore()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">RlcCore::RlcCore </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Standard Constructor </p>

</div>
</div>
<a id="a583a1eb22d4e0a112998d195d733cb75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a583a1eb22d4e0a112998d195d733cb75">&#9670;&nbsp;</a></span>~RlcCore()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">RlcCore::~RlcCore </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Standard Destructor </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4574f7e2ec51323c53bf2f32fb94c986"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4574f7e2ec51323c53bf2f32fb94c986">&#9670;&nbsp;</a></span>addFrame()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RlcCore::addFrame </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_abstract_frame.html">AbstractFrame</a>&#160;</td>
          <td class="paramname"><em>frame</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Adds a received frame to the </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname"><a class="el" href="struct_abstract_frame.html" title="The AbstractFrame is a data structure to decouple packet representation from the internal OMNeT++/INE...">AbstractFrame</a></td><td>frame: The frame to be stored </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a08d196d5209401ed68cd99d7ec2875f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08d196d5209401ed68cd99d7ec2875f0">&#9670;&nbsp;</a></span>addPacket()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RlcCore::addPacket </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_abstract_packet.html">AbstractPacket</a>&#160;</td>
          <td class="paramname"><em>packet</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Adds a packet received from the network layer </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname"><a class="el" href="struct_abstract_packet.html" title="The AbstractPacket is a data structure to decouple packet representation from the internal OMNeT++/IN...">AbstractPacket</a></td><td>packet: The packet received </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a71b029f8a8e64f46dc27815ca1e7f27a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71b029f8a8e64f46dc27815ca1e7f27a">&#9670;&nbsp;</a></span>getCompletePackets()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vector&lt;<a class="el" href="struct_abstract_packet.html">AbstractPacket</a>&gt; RlcCore::getCompletePackets </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>returns all complete packets </p><dl class="section return"><dt>Returns</dt><dd>A list of all successfully reassembled packets </dd></dl>

</div>
</div>
<a id="a7c9ad4e279f99d546d621442acea6064"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c9ad4e279f99d546d621442acea6064">&#9670;&nbsp;</a></span>getFrame()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_abstract_frame.html">AbstractFrame</a> RlcCore::getFrame </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>size</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>returns a frame in the required size </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">int</td><td>size: Size of the required frame. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a02472c960e8a4bd52c3ae638f055af0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02472c960e8a4bd52c3ae638f055af0e">&#9670;&nbsp;</a></span>hasFrame()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool RlcCore::hasFrame </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>determines whether there is still a frame to send </p><dl class="section return"><dt>Returns</dt><dd>decision whether there is a frame </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a97af5f125410bb76b884e130b7602262"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97af5f125410bb76b884e130b7602262">&#9670;&nbsp;</a></span>packetQueue</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">vector&lt;<a class="el" href="struct_abstract_packet.html">AbstractPacket</a>&gt; RlcCore::packetQueue</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Vector to hold all received packets not transmitted yet </p>

</div>
</div>
<a id="a48c71d3a03e5e2231b38b3b2722cfc43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48c71d3a03e5e2231b38b3b2722cfc43">&#9670;&nbsp;</a></span>receivedFrames</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">vector&lt;<a class="el" href="struct_abstract_frame.html">AbstractFrame</a>&gt; RlcCore::receivedFrames</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Vector to hold all received frames </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/rlc/<a class="el" href="_rlc_core_8h_source.html">RlcCore.h</a></li>
<li>src/rlc/RlcCore.cc</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.19
</small></address>
</body>
</html>
